home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 47 / Amiga Format AFCD47 (Issue 131, Xmas 1999).iso / -serious- / comms / www / openurl / openurl.readme < prev    next >
Text File  |  1999-10-17  |  7KB  |  176 lines
  1. Introduction
  2. ¯¯¯¯¯¯¯¯¯¯¯¯
  3. This library was created to make it easier for application programmers to
  4. include clickable URLs in their applications, about windows, etc.  Current
  5. solutions to this problem typically are to launch an ARexx script or just
  6. support a few webbrowsers, with no room for configuration.  This leads to
  7. countless reinventions of the wheel (how many SendURLToBrowser.rexx scripts
  8. do you have on your harddisk?).
  9.  
  10. This library solves the problem by giving application programmers a very
  11. simple API to handle (one function) and the user gets configurability with
  12. the included preference program.
  13.  
  14. NOTE: I like and use MUI, therefore the included preference program uses
  15.       MUI.  This library is meant to be completely universal though, so
  16.       programmers preferring other GUI engines are encouraged to program 
  17.       their own preference editor and send it to me, I'll happily include it.
  18.  
  19. Requirements
  20. ¯¯¯¯¯¯¯¯¯¯¯¯
  21.  · AmigaOS 2.0 or higher.
  22.  · MUI 3.8 or higher, for the preference program only.
  23.  
  24. Features
  25. ¯¯¯¯¯¯¯¯
  26.  · Sends URL by ARexx if your browser is launched, if not, the library will
  27.    launch the browser.
  28.  · Configuration supports a list of installed browsers, no Wind*ws "default
  29.    browser" nonsense.
  30.  · mailto: URLs can optionally be handled by an email application.
  31.  · Extremely simple API for applications.
  32.  · API also available for use from ARexx scripts.
  33.  · Complete source included for your enjoyment.
  34.  
  35. Usage
  36. ¯¯¯¯¯
  37. Using the preference program should hopefully be very easy.  A few tips
  38. might be helpful though.  The library will try contacting the browsers from
  39. top to bottom of the list, so put your favourite browser at the top (drag
  40. and drop).
  41.  
  42. The ARexx portname should be set to "BROWSER" even for browsers that call
  43. their ports "BROWSER.1", "BROWSER.2", etc.  The library will look for any
  44. port named "BROWSER.x" where "x" is a number and ".x" is optional.
  45.  
  46. For developers: see autodocs.
  47.  
  48. Legal stuff
  49. ¯¯¯¯¯¯¯¯¯¯¯
  50. The openurl package is placed in the public domain.  I assume no
  51. responsibility for what these programs might do, you are using them at your
  52. own risk.
  53.  
  54. Author
  55. ¯¯¯¯¯¯
  56. SnailMail: Troels Walsted Hansen
  57.            O.L. Aunesgate 15
  58.            9009 Tromsø
  59.            NORWAY
  60.  
  61. Email:     troels@thule.no
  62.  
  63. IRC nick:  Troels
  64.  
  65.  
  66. Version history
  67. ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  68. Libs/openurl.library 1.0 (27.7.98)
  69. Prefs/OpenURL 1.0 (27.7.98)
  70. C/OpenURL 1.0 (27.7.98)
  71.  · First release to Aminet.
  72.  
  73. -- OpenURL Release 1.0 --
  74.  
  75. Libs/openurl.library 1.1 (13.12.98)
  76.  · Added quotes around formatting codes in the default prefs.
  77.  · Released together with WebVision 2.0.
  78.  
  79. Libs/openurl.library 2.0 (4.2.99)
  80.  · Much more efficient searching for browser ARexx ports.
  81.  · Asynchronous ARexx commandsending through use of new OpenURL-Handler.
  82.    This prevents apps using OpenURL from locking up if there is for example a
  83.    crashed browser hanging around in the system.
  84.    (Ian Kumlien)
  85.  · Changed the way URLs are sent to browsers. The new scheme works like this:
  86.    - Search for any started browser, if found, send URL to that.
  87.    - If not found, start the first browser that is configured with full path.
  88.    (Suggested by many people)
  89.  · Added preconfigured path for AWeb and reading of environment variable to
  90.    get Voyager path.
  91.  · Added configurable defaults for the various tags supported by URL_Open().
  92.    (Marcel Beck)
  93.  · Added URL_GetDefaultPrefs() function and bumped to V2.
  94.  · Added a up_Flags field to the prefsstructure, currently only contains a
  95.    runtime only flag, UPF_ISDEFAULTS.
  96.    (Marcin Orlowski)
  97.  · Added the "moreHTML" offline only browser to the default prefs.
  98.    (Thomas Aglassinger)
  99.  
  100. L/OpenURL-Handler 1.0 (4.2.99)
  101.  · First release to Aminet.
  102.  
  103. Prefs/OpenURL 2.0 (4.2.99)
  104.  · Fixed bug that gave hits when prefs-version-unknown requester was displayed.
  105.  · Added "Project/About..." menuitem (crowd goes wild).
  106.    (Thomas Aglassinger)
  107.  · Redesigned and reimplemented half the program to support configurable
  108.    defaults.  The new options enforced splitting the program into a main
  109.    window and a browser edit window, so the layout wouldn't become big and
  110.    ugly.
  111.  · Added "Project/Restore defaults" menuitem.
  112.  · Added "Information" tab that explains how to configure OpenURL.
  113.  
  114. C/Example 1.1 (4.2.99)
  115.  · Renamed from OpenURL and removed binary from distribution archive, OpenURL
  116.    is replaced by a more functional app by Thomas Aglassinger.
  117.  · Added a linefeed in an errormessage. ;)
  118.  
  119. C/OpenURL 1.1 (4.2.99)
  120.  · Updated by Thomas Aglassinger to use SmartReadArgs (allows launch from
  121.    Workbench, for example in project icons) and more functional arguments.
  122.  
  123. -- OpenURL Release 2.0 --
  124.  
  125. Prefs/OpenURL 3.0 (26.9.99)
  126.  · New stringgadget preference order is TextInput, BetterString, String.
  127.  · Automatically opens edit window when adding a new browser to the 
  128.    configuration.
  129.    (Mario Cattaneo)
  130.  · Now strips ".<number>" extensions from ARexx ports selected in the 
  131.    pop-port gadget.
  132.    (Mario Cattaneo)
  133.  · Updated to handle new V3 prefs.
  134.  · Now uses Popplaceholder.mcc by Marcin Orîowski.
  135.  · Uses new Popplaceholder.mcc ASL mode.
  136.  
  137. Libs/openurl.library 3.0 (26.9.99)
  138.  · Added URL_LaunchPrefsApp() function to do just that.
  139.  · "http://" is now optionally prepended to URLs lacking a scheme.  Note that
  140.    this is a slightly dodgy thing to do, because an URL like "www.thule.no:80"
  141.    actually looks like a perfectly valid <scheme>:<rest> according to RFC1738
  142.    (the dot is a valid character in a scheme). OpenURL will prepend "http://"
  143.    to such a such a string, it only allows alphanumeric characters, '+' and 
  144.    '-' in schemes. Checking for a hardcoded set of known schemes would be 
  145.    even worse. The moral of the story is: write full URLs, including scheme.
  146.    (Neil Bothwick)
  147.  · Added optional special handling for mailto: URLs.  It works similarly to
  148.    the browser support, except the WriteMail ARexx command and the mailer
  149.    commandline supports a number of placeholders for email address, subject,
  150.    etc.
  151.    (Several)
  152.  · For consistency with the mailto: support, UBNF_URLONCMDLINE is now 
  153.    obsolete, and so is %s as a placeholder for the URL in the OpenURL(W)Cmd
  154.    templates. %u should be used instead both places. The prefs loader will 
  155.    transparently handle this for old configurations.
  156.  · Cleaned up UserLibInit a little, there were a couple of memory leaks if
  157.    the handler failed to load.
  158.  · Added an ARexx function host at offset -66. To load:
  159.    IF ~SHOW('L','openurl.library') THEN
  160.       CALL ADDLIB('openurl.library',3,-66)
  161.    Functions are:
  162.    success = OPENURLPREFS()
  163.    success = OPENURL(URL/A,SHOW/S,NOSHOW/S,TOFRONT/S,NOTOFRONT/S,NEWWIN/S,
  164.                      NONEWWIN/S,LAUNCH/S,NOLAUNCH/S)
  165.    (Sigbjørn Skjæret)
  166.  · Quotes around "%u" in default prefs commandlines as well as when converting 
  167.    V2 prefs to V3.
  168.  · Prefs would be considered defaults even after a save.
  169.  · Added THOR SendMail.br script by Neil Bothwick to defaults.
  170.  · Fixed a bug in the argument parsing for the ARexx function OPENURL().
  171.  
  172. C/Example 1.2 (26.9.99)
  173.  · Added LAUNCHPREFS switch to test URL_LaunchPrefsApp().
  174.  
  175. -- OpenURL Release 3.0 --
  176.